[ISSUE-66918282] update README and swagger
diff --git a/README.md b/README.md index dd683e9..f9c5381 100644 --- a/README.md +++ b/README.md
@@ -11,5 +11,15 @@ ## Functional description -see the file [swagger.yaml](swagger.yaml). +###Configurations +* Gateway cant call "/configurations" to fetch configurations. +* "type" filter is supported. +* Long-polling is supported. +* A configuration can be fetched by id "/configurations/{configId}" + +###Blobs +* A blob can be downloaded by id "/blobs/{blobId}" + + +For details, check the file [apidGatewayConfDeploy-api.yaml](swagger.yaml).
diff --git a/apidGatewayConfDeploy-api.yaml b/apidGatewayConfDeploy-api.yaml index cc1011f..c00d79a 100644 --- a/apidGatewayConfDeploy-api.yaml +++ b/apidGatewayConfDeploy-api.yaml
@@ -48,30 +48,54 @@ in: "query" type: string description: "Long poll block duration in seconds" - - name: "If-None-Match" - in: "header" + - name: "apid-config-index" + in: "query" type: string - description: "ETag value from request in previous request" + description: "x-apid-config-index value from request in previous request" + - name: "type" + in: "query" + type: string + description: "filter configurations by type. When type filter is given, long-polling is not supported" responses: 200: description: Successful response headers: - ETag: + x-apid-config-index: type: "string" description: "client can use this for response caching" schema: $ref: '#/definitions/ConfigurationsResponse' 304: description: Not Modified, No change in response based on If-None-Match header value. Cache representation. - headers: - ETag: - type: "string" - description: "client can use this for response caching" default: description: Error response schema: $ref: '#/definitions/ErrorResponse' - + + /configurations/{configId}: + get: + tags: + - "configurations/{configId}" + description: | + Get a configuration by id + parameters: + - name: configId + in: path + required: true + type: string + description: configId + responses: + 200: + description: Successful response + schema: + $ref: '#/definitions/Configuration' + 304: + description: Not Modified, No change in response based on If-None-Match header value. Cache representation. + default: + description: Error response + schema: + $ref: '#/definitions/ErrorResponse' + /blobs/{blobId}: get: tags: @@ -123,9 +147,9 @@ contents: type: array items: - $ref: '#/definitions/Configurations' + $ref: '#/definitions/Configuration' - Configurations: + Configuration: properties: self: type: string
diff --git a/glide.yaml b/glide.yaml index ebb45f2..58d19ac 100644 --- a/glide.yaml +++ b/glide.yaml
@@ -15,7 +15,7 @@ package: github.com/apid/apidGatewayConfDeploy import: - package: github.com/apid/apid-core - version: ISSUE-66918282 + version: master - package: github.com/apigee-labs/transicator/common version: master - package: github.com/gorilla/mux