Merge pull request #1058 from openziti/issue-1044-externalId-nullable

make externalId nullable, fix template, regen stubs, add readme

rest_client_api_server/embedded_spec.go

@@ -4804,7 +4804,8 @@ func init() {
               "$ref": "#/definitions/envInfo"
             },
             "externalId": {
-              "type": "string"
+              "type": "string",
+              "x-nullable": true
             },
             "hasApiSession": {
               "type": "boolean"
@@ -10798,7 +10799,8 @@ func init() {
               "$ref": "#/definitions/envInfo"
             },
             "externalId": {
-              "type": "string"
+              "type": "string",
+              "x-nullable": true
             },
             "hasApiSession": {
               "type": "boolean"

rest_management_api_client/identity/detail_identity_responses.go

@@ -77,7 +77,7 @@ func NewDetailIdentityOK() *DetailIdentityOK {
 
 /* DetailIdentityOK describes a response with status code 200, with default header values.
 
-A signle identity
+A single identity
 */
 type DetailIdentityOK struct {
 	Payload *rest_model.DetailIdentityEnvelope

rest_management_api_server/embedded_spec.go

@@ -8651,7 +8651,7 @@ func init() {
         "operationId": "detailIdentity",
         "responses": {
           "200": {
-            "description": "A signle identity",
+            "description": "A single identity",
             "schema": {
               "$ref": "#/definitions/detailIdentityEnvelope"
             }
@@ -19916,7 +19916,8 @@ func init() {
               "$ref": "#/definitions/envInfo"
             },
             "externalId": {
-              "type": "string"
+              "type": "string",
+              "x-nullable": true
             },
             "hasApiSession": {
               "type": "boolean"
@@ -31860,7 +31861,7 @@ func init() {
         "operationId": "detailIdentity",
         "responses": {
           "200": {
-            "description": "A signle identity",
+            "description": "A single identity",
             "schema": {
               "$ref": "#/definitions/detailIdentityEnvelope"
             }
@@ -43225,7 +43226,8 @@ func init() {
               "$ref": "#/definitions/envInfo"
             },
             "externalId": {
-              "type": "string"
+              "type": "string",
+              "x-nullable": true
             },
             "hasApiSession": {
               "type": "boolean"

rest_management_api_server/operations/identity/detail_identity_responses.go

@@ -40,7 +40,7 @@ import (
 // DetailIdentityOKCode is the HTTP code returned for type DetailIdentityOK
 const DetailIdentityOKCode int = 200
 
-/*DetailIdentityOK A signle identity
+/*DetailIdentityOK A single identity
 
 swagger:response detailIdentityOK
 */

scripts/template.copyright.txt

@@ -20,4 +20,4 @@ __          __              _
    \  /\  / (_| | |  | | | | | | | | (_| | : This file is generated, do not edit it.
     \/  \/ \__,_|_|  |_| |_|_|_| |_|\__, |
                                      __/ |
-                                    |___/i
+                                    |___/

specs/README.md

@@ -0,0 +1,23 @@
+# Edge Specs
+
+This folder contains the specifications for the two current edge APIs: client, management. 
+
+## Updating a Spec
+
+If a spec has a bug and you are changing a spec please do not change these files. These 
+files are generated and should not be modified.:
+
+* ./management.yml
+* ./client.yml
+
+The actual specs to modify are located in the `./source/` folder
+
+## Updating Client/Server Stubs
+
+After modifying a file, you will need to regenerate the stub code.
+
+* Download/install `swagger` from https://github.com/go-swagger/go-swagger/releases
+* cd to the directory containing this README
+* issue either:
+** `./scripts/generate_rest.sh`
+** `powershell -file "./scripts/generate_rest.ps1"`

specs/client.yml

@@ -3485,6 +3485,7 @@ definitions:
           $ref: '#/definitions/envInfo'
         externalId:
           type: string
+          x-nullable: true
         hasApiSession:
           type: boolean
         hasEdgeRouterConnection:

specs/management.yml

@@ -14369,6 +14369,7 @@ definitions:
           $ref: '#/definitions/envInfo'
         externalId:
           type: string
+          x-nullable: true
         hasApiSession:
           type: boolean
         hasEdgeRouterConnection:

specs/source/shared/identities.yml

@@ -73,6 +73,7 @@ definitions:
             $ref: 'base-entity.yml#/definitions/tags'
           externalId:
             type: string
+            x-nullable: true
           disabled:
             type: boolean
           disabledAt: