docs: improve api headline (ory#2989)

senteca · Dec 28, 2022 · 7a9e520 · 7a9e520
1 parent fa8758e
commit 7a9e520
Show file tree

Hide file tree

Showing 7 changed files with 9 additions and 9 deletions.
diff --git a/internal/client-go/README.md b/internal/client-go/README.md
@@ -119,7 +119,7 @@ Class | Method | HTTP request | Description
 *IdentityApi* | [**ExtendSession**](docs/IdentityApi.md#extendsession) | **Patch** /admin/sessions/{id}/extend | Extend a Session
 *IdentityApi* | [**GetIdentity**](docs/IdentityApi.md#getidentity) | **Get** /admin/identities/{id} | Get an Identity
 *IdentityApi* | [**GetIdentitySchema**](docs/IdentityApi.md#getidentityschema) | **Get** /schemas/{id} | Get Identity JSON Schema
-*IdentityApi* | [**GetSession**](docs/IdentityApi.md#getsession) | **Get** /admin/sessions/{id} | This endpoint returns the session object with expandables specified.
+*IdentityApi* | [**GetSession**](docs/IdentityApi.md#getsession) | **Get** /admin/sessions/{id} | Get Session
 *IdentityApi* | [**ListIdentities**](docs/IdentityApi.md#listidentities) | **Get** /admin/identities | List Identities
 *IdentityApi* | [**ListIdentitySchemas**](docs/IdentityApi.md#listidentityschemas) | **Get** /schemas | Get all Identity Schemas
 *IdentityApi* | [**ListIdentitySessions**](docs/IdentityApi.md#listidentitysessions) | **Get** /admin/identities/{id}/sessions | List an Identity&#39;s Sessions

diff --git a/internal/client-go/api_identity.go b/internal/client-go/api_identity.go
diff --git a/internal/httpclient/README.md b/internal/httpclient/README.md
@@ -119,7 +119,7 @@ Class | Method | HTTP request | Description
 *IdentityApi* | [**ExtendSession**](docs/IdentityApi.md#extendsession) | **Patch** /admin/sessions/{id}/extend | Extend a Session
 *IdentityApi* | [**GetIdentity**](docs/IdentityApi.md#getidentity) | **Get** /admin/identities/{id} | Get an Identity
 *IdentityApi* | [**GetIdentitySchema**](docs/IdentityApi.md#getidentityschema) | **Get** /schemas/{id} | Get Identity JSON Schema
-*IdentityApi* | [**GetSession**](docs/IdentityApi.md#getsession) | **Get** /admin/sessions/{id} | This endpoint returns the session object with expandables specified.
+*IdentityApi* | [**GetSession**](docs/IdentityApi.md#getsession) | **Get** /admin/sessions/{id} | Get Session
 *IdentityApi* | [**ListIdentities**](docs/IdentityApi.md#listidentities) | **Get** /admin/identities | List Identities
 *IdentityApi* | [**ListIdentitySchemas**](docs/IdentityApi.md#listidentityschemas) | **Get** /schemas | Get all Identity Schemas
 *IdentityApi* | [**ListIdentitySessions**](docs/IdentityApi.md#listidentitysessions) | **Get** /admin/identities/{id}/sessions | List an Identity&#39;s Sessions

diff --git a/internal/httpclient/api_identity.go b/internal/httpclient/api_identity.go
diff --git a/session/handler.go b/session/handler.go
@@ -391,7 +391,7 @@ type getSession struct {
 
 // swagger:route GET /admin/sessions/{id} identity getSession
 //
-// This endpoint returns the session object with expandables specified.
+// # Get Session
 //
 // This endpoint is useful for:
 //

diff --git a/spec/api.json b/spec/api.json
@@ -4130,7 +4130,7 @@
             "oryAccessToken": []
           }
         ],
-        "summary": "This endpoint returns the session object with expandables specified.",
+        "summary": "Get Session",
         "tags": [
           "identity"
         ]

diff --git a/spec/swagger.json b/spec/swagger.json
@@ -866,7 +866,7 @@
         "tags": [
           "identity"
         ],
-        "summary": "This endpoint returns the session object with expandables specified.",
+        "summary": "Get Session",
         "operationId": "getSession",
         "parameters": [
           {