wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Replace all mentions of Swagger by OpenAPI (#1633)

Browse source 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
This commit is contained in:
Kévin Commaille 2023-09-19 19:26:07 +02:00 • committed by GitHub
parent df3f0af5d4
commit 99e2ff4927
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
17 changed files with 40 additions and 87 deletions
Download patch file Download diff file Expand all files Collapse all files

2
layouts/partials/openapi/render-api.html
View file

@ -2,7 +2,7 @@
Render an HTTP API, given:
* `api_data`: the OpenAPI/Swagger data
* `api_data`: the OpenAPI data
* `base_url`: the base URL: that is, the part we glue onto the front
of each value in `paths` to get a complete URL.
* `path`: the directory under /data where we found this API definition.

2
layouts/partials/openapi/render-operation.html
View file

@ -4,7 +4,7 @@
* `method`: the method, e.g. GET, PUT
* `endpoint`: the endpoint
* `operation_data`: the OpenAPI/Swagger data for the operation
* `operation_data`: the OpenAPI data for the operation
* `path`: the path where this definition was found, to enable us to resolve "$ref"
This template renders the operation as a `<section>` containing:

2
layouts/partials/openapi/render-parameters.html
View file

@ -2,7 +2,7 @@
Render the parameters of a given type, given:
* `parameters`: OpenAPI/Swagger data specifying the parameters
* `parameters`: OpenAPI data specifying the parameters
* `type`: the type of parameters to render: "header, ""path", "query"
* `caption`: caption to use for the table

4
layouts/partials/openapi/render-request.html
View file

@ -2,8 +2,8 @@
Render the request part of a single HTTP API operation, given:
* `parameters`: OpenAPI/Swagger data specifying the parameters
* `request_body`: OpenAPI/Swagger data specifying the request body
* `parameters`: OpenAPI data specifying the parameters
* `request_body`: OpenAPI data specifying the request body
* `path`: the path where this definition was found, to enable us to resolve "$ref"
* `anchor_base`: a prefix to add to the HTML anchors generated for each object

2
layouts/partials/openapi/render-responses.html
View file

@ -2,7 +2,7 @@
Render the response part of a single HTTP API operation, given:
* `responses`: OpenAPI/Swagger data specifying the responses
* `responses`: OpenAPI data specifying the responses
* `path`: the path where this definition was found, to enable us to resolve "$ref"
* `anchor_base`: a prefix to add to the HTML anchors generated for each object