Add OperationIDs to third party resources spec

mbohlool · mbohlool · commit 1672ded33027 · 2017-05-19T15:26:08.000-07:00
diff --git a/scripts/preprocess_spec.py b/scripts/preprocess_spec.py
@@ -34,6 +34,8 @@
 
 OUTPUT_PATH = os.path.join(os.path.dirname(__file__), 'swagger.json')
 
+TPR_SPEC_PATH = os.path.join(os.path.dirname(__file__), 'thirdpartypaths.json')
+
 _ops = ['get', 'put', 'post', 'delete', 'options', 'head', 'patch']
 
 
@@ -103,7 +105,7 @@ def strip_tags_from_operation_id(operation, _):
 
 
 def add_thirdparty_resource_paths(spec):
-    with open('thirdpartypaths.json', 'r') as third_party_spec_file:
+    with open(TPR_SPEC_PATH, 'r') as third_party_spec_file:
         third_party_spec = json.loads(third_party_spec_file.read())
     for path in third_party_spec.keys():
         if path not in spec['paths'].keys():
diff --git a/scripts/thirdpartypaths.json b/scripts/thirdpartypaths.json
@@ -1,6 +1,7 @@
 {
   "/apis/{fqdn}/v1/{resource}": {
     "get": {
+      "operationId": "listThirdPartyResource",
       "security": [
         {
           "Bearer": [
@@ -48,6 +49,7 @@
   },
   "/apis/{fqdn}/v1/namespaces/{namespace}/{resource}": {
     "post": {
+      "operationId": "createThirdPartyResource",
       "security": [
         {
           "Bearer": [
@@ -104,6 +106,7 @@
   },
   "/apis/{fqdn}/v1/namespaces/{namespace}/{resource}/{name}": {
     "get": {
+      "operationId": "getThirdPartyResource",
       "security": [
         {
           "Bearer": [
@@ -156,6 +159,7 @@
       }
     },
     "delete": {
+      "operationId": "deleteThirdPartyResource",
       "security": [
         {
           "Bearer": [
@@ -209,15 +213,16 @@
       }
     },
     "put": {
+      "operationId": "updateThirdPartyResource",
       "security": [
         {
           "Bearer": [
 
           ]
         }
       ],
-      "summary": "Replace a Resource",
-      "description": "Replaces the specified third party resource of the type specified",
+      "summary": "Update a Resource",
+      "description": "Update the specified third party resource of the type specified",
       "tags": [
         "third_party_resources"
       ],

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"/apis/{fqdn}/v1/{resource}": {`
`3`	`3`	`"get": {`
	`4`	`+ "operationId": "listThirdPartyResource",`
`4`	`5`	`"security": [`
`5`	`6`	`{`
`6`	`7`	`"Bearer": [`
`@@ -48,6 +49,7 @@`
`48`	`49`	`},`
`49`	`50`	`"/apis/{fqdn}/v1/namespaces/{namespace}/{resource}": {`
`50`	`51`	`"post": {`
	`52`	`+ "operationId": "createThirdPartyResource",`
`51`	`53`	`"security": [`
`52`	`54`	`{`
`53`	`55`	`"Bearer": [`
`@@ -104,6 +106,7 @@`
`104`	`106`	`},`
`105`	`107`	`"/apis/{fqdn}/v1/namespaces/{namespace}/{resource}/{name}": {`
`106`	`108`	`"get": {`
	`109`	`+ "operationId": "getThirdPartyResource",`
`107`	`110`	`"security": [`
`108`	`111`	`{`
`109`	`112`	`"Bearer": [`
`@@ -156,6 +159,7 @@`
`156`	`159`	`}`
`157`	`160`	`},`
`158`	`161`	`"delete": {`
	`162`	`+ "operationId": "deleteThirdPartyResource",`
`159`	`163`	`"security": [`
`160`	`164`	`{`
`161`	`165`	`"Bearer": [`
`@@ -209,15 +213,16 @@`
`209`	`213`	`}`
`210`	`214`	`},`
`211`	`215`	`"put": {`
	`216`	`+ "operationId": "updateThirdPartyResource",`
`212`	`217`	`"security": [`
`213`	`218`	`{`
`214`	`219`	`"Bearer": [`
`215`	`220`
`216`	`221`	`]`
`217`	`222`	`}`
`218`	`223`	`],`
`219`		`- "summary": "Replace a Resource",`
`220`		`- "description": "Replaces the specified third party resource of the type specified",`
	`224`	`+ "summary": "Update a Resource",`
	`225`	`+ "description": "Update the specified third party resource of the type specified",`
`221`	`226`	`"tags": [`
`222`	`227`	`"third_party_resources"`
`223`	`228`	`],`