Content type method

packages/openapi-to-graphql/lib/oas_3_tools.d.ts

@@ -28,8 +28,20 @@ export declare type ResponseSchemaAndNames = {
     responseSchemaNames?: SchemaNames;
     statusCode?: string;
 };
-export declare const OAS_OPERATIONS: string[];
+export declare enum HTTP_METHODS {
+    'get' = "get",
+    'put' = "put",
+    'post' = "post",
+    'patch' = "patch",
+    'delete' = "delete",
+    'options' = "options",
+    'head' = "head"
+}
 export declare const SUCCESS_STATUS_RX: RegExp;
+/**
+ * Given an HTTP method, convert it to the HTTP_METHODS enum
+ */
+export declare function methodToHttpMethod(method: string): HTTP_METHODS;
 /**
  * Resolves on a validated OAS 3 for the given spec (OAS 2 or OAS 3), or rejects
  * if errors occur.
@@ -98,7 +110,7 @@ export declare function getRequestBodyObject(operation: OperationObject, oas: Oa
  * a dictionary of names from different sources (if available), and whether the
  * request schema is required for the operation.
  */
-export declare function getRequestSchemaAndNames(path: string, method: string, operation: OperationObject, oas: Oas3): RequestSchemaAndNames;
+export declare function getRequestSchemaAndNames(path: string, method: HTTP_METHODS, operation: OperationObject, oas: Oas3): RequestSchemaAndNames;
 /**
  * Returns JSON-compatible schema produced by the given operation
  */
@@ -111,21 +123,21 @@ export declare function getResponseObject(operation: OperationObject, statusCode
  * a successful  status code, and a dictionary of names from different sources
  * (if available).
  */
-export declare function getResponseSchemaAndNames<TSource, TContext, TArgs>(path: string, method: string, operation: OperationObject, oas: Oas3, data: PreprocessingData<TSource, TContext, TArgs>, options: InternalOptions<TSource, TContext, TArgs>): ResponseSchemaAndNames;
+export declare function getResponseSchemaAndNames<TSource, TContext, TArgs>(path: string, method: HTTP_METHODS, operation: OperationObject, oas: Oas3, data: PreprocessingData<TSource, TContext, TArgs>, options: InternalOptions<TSource, TContext, TArgs>): ResponseSchemaAndNames;
 /**
  * Returns a success status code for the given operation
  */
 export declare function getResponseStatusCode<TSource, TContext, TArgs>(path: string, method: string, operation: OperationObject, oas: Oas3, data: PreprocessingData<TSource, TContext, TArgs>): string | void;
 /**
  * Returns a hash containing the links in the given operation.
  */
-export declare function getLinks<TSource, TContext, TArgs>(path: string, method: string, operation: OperationObject, oas: Oas3, data: PreprocessingData<TSource, TContext, TArgs>): {
+export declare function getLinks<TSource, TContext, TArgs>(path: string, method: HTTP_METHODS, operation: OperationObject, oas: Oas3, data: PreprocessingData<TSource, TContext, TArgs>): {
     [key: string]: LinkObject;
 };
 /**
  * Returns the list of parameters in the given operation.
  */
-export declare function getParameters(path: string, method: string, operation: OperationObject, pathItem: PathItemObject, oas: Oas3): ParameterObject[];
+export declare function getParameters(path: string, method: HTTP_METHODS, operation: OperationObject, pathItem: PathItemObject, oas: Oas3): ParameterObject[];
 /**
  * Returns an array of server objects for the operation at the given path and
  * method. Considers in the following order: global server definitions,
@@ -172,7 +184,7 @@ export declare function trim(str: string, length: number): string;
  * Determines if the given "method" is indeed an operation. Alternatively, the
  * method could point to other types of information (e.g., parameters, servers).
  */
-export declare function isOperation(method: string): boolean;
+export declare function isHttpMethod(method: string): boolean;
 /**
  * Formats a string that describes an operation in the form:
  * {name of OAS} {HTTP method in ALL_CAPS} {operation path}
@@ -191,4 +203,4 @@ export declare function uncapitalize(str: string): string;
 /**
  * For operations that do not have an operationId, generate one
  */
-export declare function generateOperationId(method: string, path: string): string;
+export declare function generateOperationId(method: HTTP_METHODS, path: string): string;

packages/openapi-to-graphql/lib/types/operation.d.ts

@@ -5,6 +5,7 @@
 import { Oas3, LinkObject, ParameterObject, ServerObject, SchemaObject } from './oas3';
 import { GraphQLOperationType } from './graphql';
 import { GraphQLScalarType, GraphQLObjectType, GraphQLInputObjectType, GraphQLList, GraphQLEnumType, GraphQLUnionType } from 'graphql';
+import { HTTP_METHODS } from '../oas_3_tools';
 import * as GraphQLJSON from 'graphql-type-json';
 export declare type DataDefinition = {
     preferredName: string;
@@ -65,7 +66,7 @@ export declare type Operation = {
     /**
      * HTTP method for this operation
      */
-    method: string;
+    method: HTTP_METHODS;
     /**
      * Content-type of the request payload
      */

packages/openapi-to-graphql/lib/utils.d.ts

@@ -12,6 +12,7 @@ export declare enum MitigationTypes {
     COMBINE_SCHEMAS = "COMBINE_SCHEMAS",
     DUPLICATE_FIELD_NAME = "DUPLICATE_FIELD_NAME",
     DUPLICATE_LINK_KEY = "DUPLICATE_LINK_KEY",
+    INVALID_HTTP_METHOD = "INVALID_HTTP_METHOD",
     INPUT_UNION = "INPUT_UNION",
     MISSING_RESPONSE_SCHEMA = "MISSING_RESPONSE_SCHEMA",
     MISSING_SCHEMA = "MISSING_SCHEMA",