docs: use NYT Capitalization for all Swagger headlines (#675)

Closes #664

.schema/api.swagger.json

@@ -408,7 +408,7 @@
     },
     "/schemas/{id}": {
       "get": {
-        "description": "Get a traits schema definition",
+        "description": "Get a Traits Schema Definition",
         "produces": [
           "application/json"
         ],
@@ -463,7 +463,7 @@
         "tags": [
           "public"
         ],
-        "summary": "Initialize browser-based login user flow",
+        "summary": "Initialize Browser-Based Login User Flow",
         "operationId": "initializeSelfServiceBrowserLoginFlow",
         "parameters": [
           {
@@ -521,7 +521,7 @@
         "tags": [
           "public"
         ],
-        "summary": "Initialize browser-based account recovery flow",
+        "summary": "Initialize Browser-Based Account Recovery Flow",
         "operationId": "initializeSelfServiceRecoveryFlow",
         "responses": {
           "302": {
@@ -549,7 +549,7 @@
         "tags": [
           "public"
         ],
-        "summary": "Complete the browser-based recovery flow using a recovery link",
+        "summary": "Complete the Browser-Based Recovery Flow Using a Recovery Link",
         "operationId": "completeSelfServiceBrowserRecoveryLinkStrategyFlow",
         "parameters": [
           {
@@ -596,7 +596,7 @@
         "tags": [
           "public"
         ],
-        "summary": "Initialize browser-based registration user flow",
+        "summary": "Initialize Browser-Based Registration User Flow",
         "operationId": "initializeSelfServiceBrowserRegistrationFlow",
         "responses": {
           "302": {
@@ -625,7 +625,7 @@
         "tags": [
           "public"
         ],
-        "summary": "Complete the browser-based settings flow for the OpenID Connect strategy",
+        "summary": "Complete the Browser-Based Settings Flow for the OpenID Connect Strategy",
         "operationId": "completeSelfServiceBrowserSettingsOIDCSettingsFlow",
         "responses": {
           "302": {
@@ -655,7 +655,7 @@
           "public",
           "admin"
         ],
-        "summary": "Get the request context of browser-based login user flows",
+        "summary": "Get the Request Context Browser-Based Login User Flows",
         "operationId": "getSelfServiceBrowserLoginRequest",
         "parameters": [
           {
@@ -715,7 +715,7 @@
           "public",
           "admin"
         ],
-        "summary": "Get the request context of browser-based recovery flows",
+        "summary": "Get the Request Context of Browser-Based Recovery Flows",
         "operationId": "getSelfServiceBrowserRecoveryRequest",
         "parameters": [
           {
@@ -775,7 +775,7 @@
           "public",
           "admin"
         ],
-        "summary": "Get the request context of browser-based registration user flows",
+        "summary": "Get the Request Context of Browser-Based Registration User Flows",
         "operationId": "getSelfServiceBrowserRegistrationRequest",
         "parameters": [
           {
@@ -835,7 +835,7 @@
           "public",
           "admin"
         ],
-        "summary": "Get the request context of browser-based settings flows",
+        "summary": "Get the Request Context of Browser-Based Settings Flows",
         "operationId": "getSelfServiceBrowserSettingsRequest",
         "parameters": [
           {
@@ -895,7 +895,7 @@
           "public",
           "admin"
         ],
-        "summary": "Get the request context of browser-based verification flows",
+        "summary": "Get the Request Context of Browser-Based Verification Flows",
         "operationId": "getSelfServiceVerificationRequest",
         "parameters": [
           {
@@ -944,7 +944,7 @@
         "tags": [
           "public"
         ],
-        "summary": "Initialize browser-based settings flow",
+        "summary": "Initialize Browser-Based Settings Flow",
         "operationId": "initializeSelfServiceSettingsFlow",
         "responses": {
           "302": {
@@ -973,7 +973,7 @@
         "tags": [
           "public"
         ],
-        "summary": "Complete the browser-based settings flow for the password strategy",
+        "summary": "Complete the Browser-Based Settings Flow for the Password Strategy",
         "operationId": "completeSelfServiceBrowserSettingsPasswordStrategyFlow",
         "responses": {
           "302": {
@@ -1002,7 +1002,7 @@
         "tags": [
           "public"
         ],
-        "summary": "Complete the browser-based settings flow for profile data",
+        "summary": "Complete the Browser-Based Settings Flow for Profile Data",
         "operationId": "completeSelfServiceBrowserSettingsProfileStrategyFlow",
         "parameters": [
           {
@@ -1044,7 +1044,7 @@
         "tags": [
           "public"
         ],
-        "summary": "Initialize browser-based verification flow",
+        "summary": "Initialize Browser-Based Verification Flow",
         "operationId": "initializeSelfServiceBrowserVerificationFlow",
         "parameters": [
           {
@@ -1082,7 +1082,7 @@
         "tags": [
           "public"
         ],
-        "summary": "Complete the browser-based verification flows",
+        "summary": "Complete the Browser-Based Verification Flows",
         "operationId": "completeSelfServiceBrowserVerificationFlow",
         "parameters": [
           {
@@ -1127,7 +1127,7 @@
         "tags": [
           "public"
         ],
-        "summary": "Complete the browser-based verification flows",
+        "summary": "Complete the Browser-Based Verification Flows",
         "operationId": "selfServiceBrowserVerify",
         "parameters": [
           {
@@ -1172,7 +1172,7 @@
           "public",
           "admin"
         ],
-        "summary": "Get user-facing self-service errors",
+        "summary": "Get User-Facing Self-Service Errors",
         "operationId": "getSelfServiceError",
         "parameters": [
           {
@@ -1222,7 +1222,7 @@
         "tags": [
           "public"
         ],
-        "summary": "Check who the current HTTP session belongs to",
+        "summary": "Check Who the Current HTTP Session Belongs To",
         "operationId": "whoami",
         "responses": {
           "200": {

schema/handler.go

@@ -65,7 +65,7 @@ type getSchemaParameters struct {
 
 // swagger:route GET /schemas/{id} common public admin getSchema
 //
-// Get a traits schema definition
+// Get a Traits Schema Definition
 //
 //     Produces:
 //     - application/json

selfservice/errorx/handler.go

@@ -67,7 +67,7 @@ type errorContainerParameters struct {
 
 // swagger:route GET /self-service/errors common public admin getSelfServiceError
 //
-// Get user-facing self-service errors
+// Get User-Facing Self-Service Errors
 //
 // This endpoint returns the error associated with a user-facing self service errors.
 //

selfservice/flow/login/handler.go

@@ -89,7 +89,7 @@ type initializeSelfServiceBrowserLoginFlow struct {
 
 // swagger:route GET /self-service/browser/flows/login public initializeSelfServiceBrowserLoginFlow
 //
-// Initialize browser-based login user flow
+// Initialize Browser-Based Login User Flow
 //
 // This endpoint initializes a browser-based user login flow. Once initialized, the browser will be redirected to
 // `selfservice.flows.login.ui_url` with the request ID set as a query parameter. If a valid user session exists already, the browser will be
@@ -155,7 +155,7 @@ type getSelfServiceBrowserLoginRequestParameters struct {
 
 // swagger:route GET /self-service/browser/flows/requests/login common public admin getSelfServiceBrowserLoginRequest
 //
-// Get the request context of browser-based login user flows
+// Get the Request Context Browser-Based Login User Flows
 //
 // This endpoint returns a login request's context with, for example, error details and
 // other information.

selfservice/flow/recovery/handler.go

@@ -59,7 +59,7 @@ func (h *Handler) RegisterAdminRoutes(admin *x.RouterAdmin) {
 
 // swagger:route GET /self-service/browser/flows/recovery public initializeSelfServiceRecoveryFlow
 //
-// Initialize browser-based account recovery flow
+// Initialize Browser-Based Account Recovery Flow
 //
 // This endpoint initializes a browser-based account recovery flow. Once initialized, the browser will be redirected to
 // `selfservice.flows.recovery.ui_url` with the request ID set as a query parameter. If a valid user session exists, the request
@@ -108,7 +108,7 @@ type getSelfServiceBrowserRecoveryRequestParameters struct {
 
 // swagger:route GET /self-service/browser/flows/requests/recovery common public admin getSelfServiceBrowserRecoveryRequest
 //
-// Get the request context of browser-based recovery flows
+// Get the Request Context of Browser-Based Recovery Flows
 //
 // When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required
 // for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes

selfservice/flow/registration/handler.go

@@ -76,7 +76,7 @@ func (h *Handler) NewRegistrationRequest(w http.ResponseWriter, r *http.Request)
 
 // swagger:route GET /self-service/browser/flows/registration public initializeSelfServiceBrowserRegistrationFlow
 //
-// Initialize browser-based registration user flow
+// Initialize Browser-Based Registration User Flow
 //
 // This endpoint initializes a browser-based user registration flow. Once initialized, the browser will be redirected to
 // `selfservice.flows.registration.ui_url` with the request ID set as a query parameter. If a valid user session exists already, the browser will be
@@ -121,7 +121,7 @@ type getSelfServiceBrowserRegistrationRequestParameters struct {
 
 // swagger:route GET /self-service/browser/flows/requests/registration common public admin getSelfServiceBrowserRegistrationRequest
 //
-// Get the request context of browser-based registration user flows
+// Get the Request Context of Browser-Based Registration User Flows
 //
 // This endpoint returns a registration request's context with, for example, error details and
 // other information.

selfservice/flow/settings/handler.go

@@ -81,7 +81,7 @@ func (h *Handler) RegisterAdminRoutes(admin *x.RouterAdmin) {
 
 // swagger:route GET /self-service/browser/flows/settings public initializeSelfServiceSettingsFlow
 //
-// Initialize browser-based settings flow
+// Initialize Browser-Based Settings Flow
 //
 // This endpoint initializes a browser-based settings flow. Once initialized, the browser will be redirected to
 // `selfservice.flows.settings.ui_url` with the request ID set as a query parameter. If no valid user session exists, a login
@@ -147,7 +147,7 @@ type getSelfServiceBrowserSettingsRequestParameters struct {
 
 // swagger:route GET /self-service/browser/flows/requests/settings common public admin getSelfServiceBrowserSettingsRequest
 //
-// Get the request context of browser-based settings flows
+// Get the Request Context of Browser-Based Settings Flows
 //
 // When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required
 // for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes

selfservice/flow/verification/handler.go

@@ -81,7 +81,7 @@ type initializeSelfServiceVerificationFlowParameters struct {
 
 // swagger:route GET /self-service/browser/flows/verification/init/{via} public initializeSelfServiceBrowserVerificationFlow
 //
-// Initialize browser-based verification flow
+// Initialize Browser-Based Verification Flow
 //
 // This endpoint initializes a browser-based verification flow. Once initialized, the browser will be redirected to
 // `selfservice.flows.settings.ui_url` with the request ID set as a query parameter. If no valid user session exists, a login
@@ -135,7 +135,7 @@ type getSelfServiceVerificationRequestParameters struct {
 
 // swagger:route GET /self-service/browser/flows/requests/verification common public admin getSelfServiceVerificationRequest
 //
-// Get the request context of browser-based verification flows
+// Get the Request Context of Browser-Based Verification Flows
 //
 // When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required
 // for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes
@@ -205,7 +205,7 @@ type completeSelfServiceBrowserVerificationFlowParameters struct {
 
 // swagger:route POST /self-service/browser/flows/verification/{via}/complete public completeSelfServiceBrowserVerificationFlow
 //
-// Complete the browser-based verification flows
+// Complete the Browser-Based Verification Flows
 //
 // This endpoint completes a browser-based verification flow. This is usually achieved by POSTing data to this
 // endpoint.
@@ -311,7 +311,7 @@ type selfServiceBrowserVerifyParameters struct {
 
 // swagger:route GET /self-service/browser/flows/verification/{via}/confirm/{code} public selfServiceBrowserVerify
 //
-// Complete the browser-based verification flows
+// Complete the Browser-Based Verification Flows
 //
 // This endpoint completes a browser-based verification flow.
 //

selfservice/strategy/oidc/strategy_settings.go

@@ -197,7 +197,7 @@ func (p *completeSelfServiceBrowserSettingsOIDCFlowPayload) SetRequestID(rid uui
 
 // swagger:route POST /self-service/browser/flows/registration/strategies/oidc/settings/connections public completeSelfServiceBrowserSettingsOIDCSettingsFlow
 //
-// Complete the browser-based settings flow for the OpenID Connect strategy
+// Complete the Browser-Based Settings Flow for the OpenID Connect Strategy
 //
 // This endpoint completes a browser-based settings flow. This is usually achieved by POSTing data to this
 // endpoint.

selfservice/strategy/password/settings.go

@@ -59,7 +59,7 @@ func (p *completeSelfServiceBrowserSettingsPasswordFlowPayload) SetRequestID(rid
 
 // swagger:route POST /self-service/browser/flows/settings/strategies/password public completeSelfServiceBrowserSettingsPasswordStrategyFlow
 //
-// Complete the browser-based settings flow for the password strategy
+// Complete the Browser-Based Settings Flow for the Password Strategy
 //
 // This endpoint completes a browser-based settings flow. This is usually achieved by POSTing data to this
 // endpoint.

selfservice/strategy/profile/strategy.go

@@ -121,7 +121,7 @@ func (s *Strategy) PopulateSettingsMethod(r *http.Request, ss *session.Session,
 
 // swagger:route POST /self-service/browser/flows/settings/strategies/profile public completeSelfServiceBrowserSettingsProfileStrategyFlow
 //
-// Complete the browser-based settings flow for profile data
+// Complete the Browser-Based Settings Flow for Profile Data
 //
 // This endpoint completes a browser-based settings flow. This is usually achieved by POSTing data to this
 // endpoint.

selfservice/strategy/recoverytoken/strategy.go

@@ -277,7 +277,7 @@ type completeSelfServiceBrowserRecoveryLinkStrategyFlowParams struct {
 
 // swagger:route POST /self-service/browser/flows/recovery/link public completeSelfServiceBrowserRecoveryLinkStrategyFlow
 //
-// Complete the browser-based recovery flow using a recovery link
+// Complete the Browser-Based Recovery Flow Using a Recovery Link
 //
 // > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...) and HTML Forms.
 //

session/handler.go

@@ -54,7 +54,7 @@ func (h *Handler) RegisterAdminRoutes(admin *x.RouterAdmin) {
 
 // swagger:route GET /sessions/whoami public whoami
 //
-// Check who the current HTTP session belongs to
+// Check Who the Current HTTP Session Belongs To
 //
 // Uses the HTTP Headers in the GET request to determine (e.g. by using checking the cookies) who is authenticated.
 // Returns a session object in the body or 401 if the credentials are invalid or no credentials were sent.